Search Templates¶

Creating a Search Template¶

1. Go to Search Templates from the navigation bar.

Search Templates¶

2. Click Add.

Search Templates¶

3. Provide a Name and a Description.

Adding a Search Template¶

4. Enter the base queries in the Basequery list section. Enter a name and a query for each base query.

   Note

   • Use {{ and }} to enclose placeholders in the queries.

   • Click the Plus icon to add new base query fields and the Minus icon to remove the corresponding field.

5. In the Fields section, enter a Field used as a placeholder in any of the base queries, a Display Text for the field, and a default Value.

   Note

   You can provide multiple values for Field, Display Text, and Value.

6. Click Submit.

Exporting Search Templates¶

1. Go to Search Templates from the navigation bar.

2. Select the templates to export.

Search Templates¶

3. Click Export.

4. Save the exported template.

Importing Search Templates¶

1. Go to Search Templates from the navigation bar.

Search Templates¶

2. Click Import.

3. Browse for the template package file.

4. Click Upload.

Editing a Search Template¶

1. Go to Search Templates from the navigation bar.

2. Click the Edit icon in the Actions column of the search template.

Editing a Search Template¶

3. Update the information.

4. Click Submit.

Sharing Search Templates¶

You can share a search template with all the users in the system and give them the read, edit, or full permissions. Any changes made in the search templates are visible to all the shared users.

Each parameter in a shared search template is categorized into three types:

1. Global parameters can be changed only by the users with the Edit or Full permissions. Changes in the global parameters are reflected for all the users using the shared search template. The following parameters are global:

   • The name, description, queries, and field values of the search template.

   • Title and order of tabs, including creation and deletion of tabs.

   • Title, query, dimensions, and positions of widgets, including addition and deletion of widgets.

2. Personalized parameters can be changed by all the users. However, the changes in the personalized parameters are reflected only for the users making the change. The following parameters are personalized:

   • The updateable parameters

   • Selected repos

   • Time range

3. Hybrid parameters can be changed by all the users. If the user changing the parameters has the Edit or Full permissions, the changes are reflected for all the users. However, if the user has only the Read permission, the changes are reflected only for the user making the change. The following parameters are hybrid:

   • Chart types of widgets

   • Legends and legend labels of widgets

   • Trend state of widgets

To share a search template:

1. Go to Search Templates from the navigation bar.

2. Click the Share Template icon under the Actions column of the template you would like to share.

   

   Search Templates¶

   1. To share multiple Search Templates, select the respective templates. Click the More drop-down and choose Share Selected With Other Users.

   

   Search Templates¶

   2. To share all the Search Templates, click the More drop-down and choose Share All With Other Users.

   

   Search Templates¶

3. Select the users groups for all the users you want to share the search templates.

   

   Providing permissions for a shared search template¶

4. Select the Read, Edit, or Full permissions for the users. Refer to the introduction section of Sharing Search Templates for details on user permissions.

5. Click Submit

Deleting a Shared Search Template’s Owner¶

1. Go to Settings >> User Accounts from the navigation bar and click Users.

2. De-activate the user by clicking the De-Activate User icon in the Actions column.

3. Click Manage De-Activated Users.

4. Click the Delete icon in the Actions column of the user.

5. Click Yes.

Note

While deleting a shared search template’s owner, you must delete the shared template or transfer the template’s ownership to another user. You can do this from the Transfer Ownership panel that appears when you attempt to delete a user whose template is being shared.

6. To transfer the ownership, select a user from the drop-down and click Submit.

Transferring the Ownership of a Shared Search Template¶

Note

The transferred template is listed in the Search Templates page in the owner’s system.

7. To delete the user and user’s template without transferring their ownership, click Delete.

Deleting a Shared Search Template’s Owner¶

Cloning Search Templates¶

1. Go to Search Templates from the navigation bar.

2. Click the Clone icon under the Actions column of the template.

   

   Search Templates¶

   1. To clone multiple Search Templates, select the templates. Click the More drop-down and choose Clone Selected Templates.

   

   Search Templates¶

   2. To clone all the Search Templates, click the More drop-down and choose Clone All Templates.

   

   Search Templates¶

3. Enter a new Name for the cloned template.

4. Select the Replace Existing? checkbox to replace an existing template with the same name.

5. Click Clone.

Deleting Search Templates¶

1. Go to Search Templates from the navigation bar.

2. Click the Delete icon under the Actions column of the template.

   

   Search Templates¶

   1. To delete multiple Search Templates, select the respective templates. Click the More drop-down and choose Delete Selected Templates.

   

   Search Templates¶

   2. To delete all the Search Templates, click the More drop-down and choose Delete All Templates.

   

   Deleting all Search Templates¶

3. A delete confirmation dialog box appears on the screen. Click Yes to proceed.

Viewing a Search Template¶

1. Go to Search Templates from the navigation bar.

2. Click the Name of the template.

Search Templates¶

LogPoint forwards you to the Search Template View where you can access the dashboards of the corresponding search template.

From the search template view, you can perform the following tasks:

Adding a Dashboard¶

1. Click the Plus icon at the top.

Add Dashboard¶

2. Enter the name of the dashboard.

Add Dashboard Panel¶

3. Click Ok.

Note

You must add at least one dashboard to use the features of the Search Template View.

Adding a Widget¶

1. Click Add Widget.

Dashboard¶

2. Enter a Name for the widget.

Create Widget Panel¶

3. In the Query field, enter the name of a base query within {{ and }}.

4. Enter a Description and a Time-range for the widget.

Creating a Report¶

1. Click Report at the top of the dashboard.

Create Report¶

2. Enter the Report Name and an Email address.

Create Report Panel¶

3. Click Submit.

Note

You receive the report in the PDF format.

Auto-arrange the Widgets¶

Click Auto Arrange to automatically arrange the widgets in a presentable form.

Dashboard¶

Updating Parameters¶

1. Enter the new values for the variables in the panel to the right.

Update Parameters Panel¶

2. Click Override widget time range to select a time-range. The time-range you provide in this field takes precedence over the one provided for individual widgets.

3. Select the Repos in which to perform the search.

4. Click Update.

Stopping widget update¶

After clicking Update, the widgets continuously retrieve their respective logs.

Click the Stop button to stop the widgets from retrieving additional logs. Doing this pauses the visualization of all the widgets. You can only see the already received log results.

Stop Update¶

Note

• The widgets show updated values only after you click the Update button.

• Click Back to redirect to the list view of the search templates.

• The search templates remember the last visualization used on the widgets.

• You can drill-down on the search results from the non-edit mode of the widget of the search templates.